/*
 * Copyright 2011 Stefan Ferstl
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.google.code.debmavenplugin.mojo;

import org.apache.commons.lang.builder.ToStringBuilder;
import org.apache.commons.lang.builder.ToStringStyle;

/**
 * Configuration class describing a special file in Debian package. A special
 * file may have different file attributes (such as permissions, ownership,
 * etc.) than the defined defaults.
 */
public class SpecialFile {
  private String fileName;
  private String userName;
  private String groupName;
  private String fileMode;


  /**
   * Gets the file name.
   * @return The file name.
   */
  public String getFileName() {
    return this.fileName;
  }


  /**
   * Gets the name of the file's owner.
   * @return The name of the file's owner.
   */
  public String getUserName() {
    return this.userName;
  }

  /**
   * Gets the name of the file's owner group.
   * @return The name of the file's owner group.
   */
  public String getGroupName() {
    return this.groupName;
  }

  /**
   * Gets the file permissions.
   * @return The file permissions
   */
  public Integer getFileMode() {
    return Integer.parseInt(this.fileMode, 8);
  }

  /** {@inheritDoc} */
  @Override
  public String toString() {
    return ToStringBuilder.reflectionToString(this, ToStringStyle.SIMPLE_STYLE);
  }
}
